add delivery-type, year, quarter filter to admin report #401

sravfeyn · 2024-09-22T14:37:14Z

Refactor to htmx based reports
Add filters

calellowitz

General idea looks good, left a few questions. Nothing is probably blocking for now, but curious about a few choices

calellowitz · 2024-10-02T16:42:31Z

commcare_connect/templates/reports/report_table.html

+
+{% block javascript %}
+{{ block.super }}
+<!-- This is required for select2 'user' field-->


what is the select2 user field mentioned? i don't see a reference to select2 or users elsewhere in this PR

I let this be since it's needed in another PR #349

calellowitz · 2024-10-02T16:45:17Z

commcare_connect/reports/urls.py


 app_name = "reports"

 urlpatterns = [
-    path("delivery_stats", views.delivery_stats_report, name="delivery_stats_report"),
+    # path("delivery_stats", views.delivery_stats_report, name="delivery_stats_report"),


Was this left commented in the code for a specific reason? Seems like we can delete it

Not really, will remove it

calellowitz · 2024-10-02T16:46:09Z

commcare_connect/reports/views.py

-        table_data.append(data)
-    table = AdminReportTable(table_data)
-    return render(request, "reports/admin.html", context={"table": table})
+class SuperUserRequiredMixin(LoginRequiredMixin, UserPassesTestMixin):


Since this will be useful to any view that needs to enforce superusers, and isn't report specific, it would be great to pull this out of this view file and into a util/helper one.

calellowitz · 2024-10-02T16:49:27Z

commcare_connect/reports/views.py

@@ -33,7 +35,12 @@ def _get_quarters_since_start():
    return quarters


-def _get_table_data_for_quarter(quarter):
+def _get_table_data_for_quarter(quarter, delivery_type):


Unrelated to your PR except that you are already touching this code, but it would be great if we could cache this fairly aggressively, since its so expensive, although we may actually want to do that one level up and cache the entire loop over the quarters if we can. If not caching each quarter is probably still great

calellowitz · 2024-10-02T16:53:57Z

commcare_connect/reports/views.py

+    year = django_filters.ChoiceFilter(method="filter_by_ignore")
+    quarter = django_filters.ChoiceFilter(


What is the intent of these filters? It seems unlikely to be useful (especially the quarter once since if you filter to year, you have already filtered down to only four rows), but I might be missing something you had in mind

calellowitz · 2024-10-02T17:00:04Z

requirements/base.in

@@ -30,6 +30,9 @@ django-cors-headers
 # DRF-spectacular for api documentation
 drf-spectacular
 django-tables2
+django-filter


the changes in here won't take effect until you compile requirements inv requirements

calellowitz · 2024-10-02T17:01:53Z

commcare_connect/reports/views.py

+    filterset_class = DeliveryReportFilters
+
+    def get_template_names(self):
+        if self.request.htmx:


rather than add this new dependency and middleware, how would you feel about having the table just render asynchronously through a separate view call, like our other tables. That has the added benefit of not blocking the page render in the browser, which for one this slow, can be a much nicer experience, and hopefully requires less template duplication

render asynchronously through a separate view call, like our other tables.

May be I am not following this, this is an async call. The table gets re-rendered when the filters are selected/modified.

I think the advantage of this is that we just need to define a single view that has all the logic in it. I agree this particular view is slow, but may be the priority to should be to improve that?

calellowitz · 2024-10-02T17:03:12Z

commcare_connect/templates/reports/htmx_table.html

@@ -0,0 +1,87 @@
+{% extends "django_tables2/bootstrap5.html" %}


is it possible to reuse (or inherit) from the base report table we already defined?

This template is just the table part, the base report table template includes the filters and other nav-sections etc..

calellowitz · 2024-10-02T17:04:15Z

commcare_connect/templates/reports/htmx_table.html

+  {% endif %}
+{% endblock table.thead %}
+
+{% block pagination %}


Do we have pagination in this report? I was unable to find it in the view.

Yeah, we don't have pagination for this report, but this template is basically the common template that can be used everywhere. Taken from #349 (if this were merged, then this would have just been a DRY reference)

calellowitz · 2024-10-02T17:13:06Z

commcare_connect/reports/views.py

+        return self.request.user.is_superuser
+
+
+class DeliveryReportFilters(django_filters.FilterSet):


It seems like we are using django-filters in a pretty nontraditional way, based on all the overrides (filter_by_none, NonModelFilterView, etc), what functionality are we getting from it?

This was a bit of a non-traditional filter (in that it's not based on model fields), you can how useful it is in the Events PR #349

Additionally, even in this case, we don't have to worry about creating form/input and extracting it etc.

sravfeyn · 2024-10-05T18:32:22Z

Adding a screen-recording with some fake data. I have tested the updated functions _get_table_data_for_quarter manually tested them on production shell.

Screen.Recording.2024-10-05.at.11.58.22.PM.mov

calellowitz

I'm still not super comfortable with all of this (it seems to add a lot of unnecessary complexity) and especially with the pieces that seems to only matter for a different PR, it is challenging for me to understand what is relevant to this change and what is meant for something else, but in the interest of time, I will merge and deploy now. Thanks again for getting this out so quickly

sravfeyn force-pushed the sr/dsr-filters branch from c406198 to 4f37a6d Compare September 22, 2024 14:39

calellowitz reviewed Oct 2, 2024

View reviewed changes

sravfeyn force-pushed the sr/dsr-filters branch from 4f37a6d to d218ad4 Compare October 3, 2024 13:20

sravfeyn force-pushed the sr/currency branch 2 times, most recently from 35ced03 to 60b0e7b Compare October 4, 2024 11:06

sravfeyn added 5 commits October 4, 2024 19:33

add delivery-type, year, quarter filter to admin report

e612f7e

Add tests

8694d38

fix casting and csrf

d50d0f4

no need to break up by currency

72bfc1a

Break down by delivery-type

86ba8b9

sravfeyn force-pushed the sr/dsr-filters branch from d218ad4 to 86ba8b9 Compare October 5, 2024 18:21

cache report data

5617118

Base automatically changed from sr/currency to main October 6, 2024 12:48

calellowitz and others added 2 commits October 6, 2024 08:58

Merge branch 'main' into sr/dsr-filters

9db7088

update requirements

9b32541

calellowitz approved these changes Oct 6, 2024

View reviewed changes

fix test

158adde

calellowitz merged commit f14f5de into main Oct 6, 2024
2 checks passed

calellowitz deleted the sr/dsr-filters branch October 6, 2024 13:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add delivery-type, year, quarter filter to admin report #401

add delivery-type, year, quarter filter to admin report #401

sravfeyn commented Sep 22, 2024 •

edited

Loading

calellowitz left a comment

calellowitz Oct 2, 2024

sravfeyn Oct 4, 2024

calellowitz Oct 2, 2024

sravfeyn Oct 4, 2024

calellowitz Oct 2, 2024

sravfeyn Oct 4, 2024

calellowitz Oct 2, 2024

sravfeyn Oct 4, 2024

calellowitz Oct 2, 2024

calellowitz Oct 2, 2024

calellowitz Oct 2, 2024

sravfeyn Oct 4, 2024

calellowitz Oct 2, 2024

sravfeyn Oct 4, 2024

calellowitz Oct 2, 2024

sravfeyn Oct 4, 2024

calellowitz Oct 2, 2024

sravfeyn Oct 4, 2024 •

edited

Loading

sravfeyn commented Oct 5, 2024

calellowitz left a comment

		year = django_filters.ChoiceFilter(method="filter_by_ignore")
		quarter = django_filters.ChoiceFilter(

		@@ -0,0 +1,87 @@
		{% extends "django_tables2/bootstrap5.html" %}

		return self.request.user.is_superuser


		class DeliveryReportFilters(django_filters.FilterSet):

add delivery-type, year, quarter filter to admin report #401

add delivery-type, year, quarter filter to admin report #401

Conversation

sravfeyn commented Sep 22, 2024 • edited Loading

calellowitz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sravfeyn Oct 4, 2024 • edited Loading

Choose a reason for hiding this comment

sravfeyn commented Oct 5, 2024

calellowitz left a comment

Choose a reason for hiding this comment

sravfeyn commented Sep 22, 2024 •

edited

Loading

sravfeyn Oct 4, 2024 •

edited

Loading